home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 47 / Amiga Format AFCD47 (Issue 131, Xmas 1999).iso / -serious- / comms / www / awebresume / awebresume.cfg < prev    next >
Text File  |  1999-10-04  |  17KB  |  409 lines
  1.     *******************************************************************
  2.     *                                                                 *
  3.     * DO NOT EDIT THIS SECTION!                                       *
  4.     *                                                                 *
  5.     * $VER: AWebResume.cfg 1.11 (10.9.99) © 1999 Duane McDonnell      *
  6.     *                                                                 *
  7.     * For technical support e-mail tachyon@tolstoi.saccii.net.au      *
  8.     *                                                                 *
  9.     *******************************************************************
  10.     *                                                                 *
  11.     * If you modify this file, be sure to save it back to             *
  12.     * "ENVARC:AWeb3/AWebResume.cfg". If AWebResume is running in the  *
  13.     * background the new configuration settings will take effect soon *
  14.     * after saving the file as AWebResume sets up a file notification *
  15.     * on the specified path. If the filesystem does not support file  *
  16.     * notifications run AWebResume again to update its configuration  *
  17.     * buffer or reboot the system.                                    *
  18.     *                                                                 *
  19.     * Some general notes on specifying configuration settings:        *
  20.     *                                                                 *
  21.     * Boolean switches (those marked BOOL) accept either 0 or 1 as    *
  22.     * their parameters. 0 means false while 1 means true.             *
  23.     *                                                                 *
  24.     * Numerical values (those marked NUMBER) accept decimal values.   *
  25.     *                                                                 *
  26.     * Strings (those marked STRING) can either be quoted or unquoted. *
  27.     * You should quote strings if they contain spaces. For example,   *
  28.     * "this string is quoted".                                        *
  29.     *                                                                 *
  30.     *******************************************************************
  31.  
  32.  
  33.                    ************************************
  34.                    *                                  *
  35.                    * Download resume related settings *
  36.                    *                                  *
  37.                    ************************************
  38.  
  39.  
  40. ; ResumeEnable (BOOL)
  41. ;
  42. ; Set ResumeEnable to 1 to enable interrupted download detections and
  43. ; resumptions. This acts as a master switch for all resume related
  44. ; settings.
  45. ;
  46. ; Do not download to AWeb's temporary or cache paths if you want
  47. ; AWebResume to offer resume support for interrupted downloads. These
  48. ; paths (and their sub-directories) are ignored by AWebResume to prevent
  49. ; excessive and unnecessary interrupted download detections (unless AWeb
  50. ; would normally generate requesters for them). You should therefore set
  51. ; your "Save" path to a directory outside the scope of both the temporary
  52. ; and cache paths.
  53.  
  54. ResumeEnable    1
  55.  
  56.  
  57. ; AutoResume (BOOL)
  58. ;
  59. ; Set AutoResume to 1 if you want AWebResume to automatically resume
  60. ; interrupted downloads initiated via AWeb's LOAD ARexx command if a
  61. ; download path was given. AutoResume is useful for preventing
  62. ; interrupted download requesters appearing when ARexx is controlling
  63. ; an unattended download session. This setting is ignored if a user
  64. ; requested download fails (a user request is regarded as a request
  65. ; which did not come via ARexx).
  66.  
  67. AutoResume    0
  68.  
  69.  
  70. ; ReqTimeout (NUMBER)
  71. ;
  72. ; ReqTimeout specifies the number of seconds to display interrupted
  73. ; download requesters for before automatically satisfying them. This
  74. ; is to support unattended operations. Specifying 0 tells AWebResume
  75. ; not to automatically satisfy requesters but to wait for intervention
  76. ; from the user.
  77. ;
  78. ; Requesters are satisfied according to the following rules:
  79. ;
  80. ; - If the requester has a 'Resume' gadget, 'Resume' will be selected.
  81. ; - If the requester has a 'Select' gadget, 'Retry' will be selected.
  82.  
  83. ReqTimeout    120
  84.  
  85.  
  86. ; AcceptFilter (STRING)
  87. ; RejectFilter (STRING)
  88. ;
  89. ; AcceptFilter and RejectFilter are used to filter files which you
  90. ; normally wouldn't download to a file and therefore wouldn't resume.
  91. ; Filtering files helps to decrease memory usage.
  92. ;
  93. ; The pattern matching filters work in two stages. Firstly, URLs which
  94. ; match AcceptFilter are added to a list of potential URLs which might
  95. ; require resuming, then this list is further pruned by applying
  96. ; RejectFilter. Note that the filters are used to filter the 'object'
  97. ; part of a URL (the final part specifying a filename). Both filters
  98. ; are case-insensitive and should be specified in standard AmigaDOS
  99. ; format. To perform no filtering at all, set AcceptFilter to "#?"
  100. ; and RejectFilter to "~(#?)".
  101. ;
  102. ; The filters are ignored if AWeb would normally generate an "incomplete
  103. ; file" requester for an interrupted download. In this case, AWebResume
  104. ; will process the interrupt to ensure consistency with AWeb's normal
  105. ; operating behaviour.
  106.  
  107. AcceptFilter    #?
  108. RejectFilter    #?.(htm|html)
  109.  
  110.  
  111. ; HTTPTemplate  (STRING)
  112. ; HTTPSTemplate (STRING)
  113. ; FTPTemplate   (STRING)
  114. ;
  115. ; HTTPTemplate, HTTPSTemplate and FTPTemplate specify command templates
  116. ; for calling an HTTP, HTTPS and FTP resumption program respectively.
  117. ; HTTPTemplate is called for the "http://" scheme, HTTPSTemplate for
  118. ; "https://" and FTPTemplate for "ftp://".
  119. ;
  120. ; If you do not specify a template for a particular scheme then download
  121. ; resumption support will not be available for URLs using that scheme.
  122. ; Supplying no templates effectively sets ResumeEnable to 0.
  123. ;
  124. ; The command templates are similar to the normal arguments you would
  125. ; issue when invoking the programs from the shell except you specify
  126. ; tokens for AWebResume to expand prior to calling each program.
  127. ;
  128. ; AWebResume supports the following basic tokens:
  129. ;
  130. ; %u    URL of file whose download was interrupted
  131. ; %f    Full file path of interrupted download file
  132. ; %p    Proxy used to download initial part of file (¹)
  133. ; %r    URL which referred us to the URL being downloaded (²)
  134. ; %b    Browser user-agent/spoofing identification string
  135. ;
  136. ; Notes:
  137. ;
  138. ; ¹  It is recommended that you embed the proxy token in the conditional
  139. ;    proxy argument specifier (CondProxy) and use the %cp token rather
  140. ;    than %p in the template. This way, proxy information will only
  141. ;    form part of the final expanded template if a proxy was used to
  142. ;    collect the initial part of the file being resumed.
  143. ;
  144. ; ²  It is recommended that you embed the referer token in the conditional
  145. ;    referer argument specifier (CondRefer) and use the %cr token rather
  146. ;    than %r in the template. This way, referer information will not
  147. ;    form part of the final expanded template if you have enabled AWeb's
  148. ;    "browse anonymously" configuration option or if you manually entered
  149. ;    the URL or followed a local link to get to it (in which case there
  150. ;    is no referer).
  151. ;
  152. ; In addition to the basic tokens, AWebResume allows you to use conditional
  153. ; argument tokens in the template. Conditional argument tokens will only be
  154. ; included in the final template expansion if certain conditions are met.
  155. ;
  156. ; The following conditional argument tokens are supported:
  157. ;
  158. ; %cp   Conditional proxy argument token. If a proxy was used to download
  159. ;       the initial part of the file being resumed then this token, if
  160. ;       specified in the template, will be expanded to CondProxy (which
  161. ;       itself will be expanded before use). If no proxy was used this
  162. ;    token will be ignored.
  163. ;
  164. ; %cr   Conditional referer argument token. If AWeb was browsing with
  165. ;       referer information enabled then this token, if specified in
  166. ;       the template, will be expanded to CondRefer (which itself will
  167. ;    be expanded before use). If no referer information was in use,
  168. ;    either because you configured AWeb to browse anonymously or
  169. ;    because you entered the URL manually rather than following a
  170. ;    link to get to it, this token will be ignored.
  171. ;
  172. ; The following conditional argument specifiers are supported:
  173. ;
  174. ; CondProxy (STRING)
  175. ;
  176. ; Conditional proxy argument specifier. This will be expanded if the %cp
  177. ; token is encountered in a template, but only if a proxy was used to
  178. ; download the initial part of the file being resumed. You may only use
  179. ; the %p token in this specifier, all other tokens will be ignored.
  180. ;
  181. ; CondRefer (STRING)
  182. ;
  183. ; Conditional referer argument specifier. This will be expanded if the
  184. ; %cr token is encountered in a template, but only if AWeb's "browse
  185. ; anonymously" configuration option is disabled and the URL had a
  186. ; referer (you followed a non-local link to get to it). You may only
  187. ; use the %r token in this specifier, all other tokens will be ignored.
  188.  
  189. ;============================================================================
  190. ; The following template/specifier examples show how to use HTTPResume
  191. ; by Andriya Antonijevic to resume HTTP and HTTPS downloads (you need
  192. ; version 1.7 or higher to resume HTTPS downloads).
  193.  
  194. ; This version opens HTTPResume's GUI on AWeb's public screen or on the
  195. ; default public screen if AWeb's public screen is unavailable.
  196. ;
  197. HTTPTemplate    "HTTPResume URL="%u" OUTFILE="%f" %cp %cr GUI PUBSCREEN=AWeb AUTORESUME AUTOSTART AUTOEXIT"
  198.  
  199. ; This version outputs to a console window on AWeb's public screen or on
  200. ; the default public screen if AWeb's public screen is unavailable.
  201. ;
  202. ;HTTPTemplate    "HTTPResume URL="%u" OUTFILE="%f" %cp %cr AUTORESUME > "CON:////Resuming download.../AUTO/CLOSE/WAIT/INACTIVE/SCREEN AWeb""
  203.  
  204. ; This version opens HTTPResume's GUI on AWeb's public screen or on the
  205. ; default public screen if AWeb's public screen is unavailable.
  206. ;
  207. HTTPSTemplate    "HTTPResume URL="%u" OUTFILE="%f" %cp %cr GUI PUBSCREEN=AWeb AUTORESUME AUTOSTART AUTOEXIT"
  208.  
  209. ; This version outputs to a console window on AWeb's public screen or on
  210. ; the default public screen if AWeb's public screen is unavailable.
  211. ;
  212. ;HTTPSTemplate    "HTTPResume URL="%u" OUTFILE="%f" %cp %cr AUTORESUME > "CON:////Resuming download.../AUTO/CLOSE/WAIT/INACTIVE/SCREEN AWeb""
  213.  
  214. CondProxy    PROXY=%p
  215.  
  216. CondRefer    REFERER="%r"
  217. ;============================================================================
  218.  
  219.  
  220. ;============================================================================
  221. ; The following template examples show how to use GNU Wget to resume
  222. ; HTTP and FTP downloads. Note that Wget examines the URL to determine
  223. ; the file to resume to. This can cause problems if you change the
  224. ; default download filename offered by AWeb.
  225.  
  226. ;HTTPTemplate    "Wget -o "CON:////Resuming download.../AUTO/CLOSE/WAIT/INACTIVE/SCREEN AWeb" --user-agent=%b --continue "%u""
  227.  
  228. FTPTemplate    "Wget -o "CON:////Resuming download.../AUTO/CLOSE/WAIT/INACTIVE/SCREEN AWeb" --continue "%u""
  229. ;============================================================================
  230.  
  231.  
  232.                *************************************
  233.                *                                   *
  234.                * Download by mail related settings *
  235.                *                                   *
  236.                *************************************
  237.  
  238.  
  239. ; MailEnable (BOOL)
  240. ;
  241. ; Set MailEnable to 1 if you want AWebResume to give you the option of
  242. ; obtaining an interrupted download via your e-mail account. This is
  243. ; useful for stubborn files which AWeb and/or the resume program can't
  244. ; seem to download in full. If this option is set a 'Mail' gadget will
  245. ; appear in AWebResume's interrupted download requester. The download
  246. ; request will be sent to downloadslave.com for processing. This service
  247. ; requires that you obtain a password before submitting download requests.
  248. ; Refer to the MailPassword discussion for further information.
  249. ;
  250. ; ResumeEnable must also be set for this option to have any effect.
  251.  
  252. MailEnable    0
  253.  
  254.  
  255. ; MailPassword (STRING)
  256. ;
  257. ; This string should be set to the password issued to you by
  258. ; downloadslave.com. The password is assigned to the address you send
  259. ; the request from so be sure to sign up with the account you want
  260. ; download requests sent to. Mail data@downloadslave.com with the
  261. ; subject set to "REQUEST PASSWORD" (no quotes) and enter the password
  262. ; you receive back below. If you lose your password send mail to the
  263. ; same address with the subject set to "REMEMBER PASSWORD".
  264.  
  265. MailPassword    your_password
  266.  
  267.  
  268. ; MailAccount (STRING)
  269. ;
  270. ; Set MailAccount to the e-mail account where you want download requests
  271. ; sent to (the password specified in MailPassword must be assigned to
  272. ; this account). This address takes precedence over the Reply-To:
  273. ; address set in AWeb. If you do not specify this setting then AWeb's
  274. ; Reply-To: address from the network settings will be used.
  275.  
  276. MailAccount    user@domain.com
  277.  
  278.  
  279. ; MailTemplate (STRING)
  280. ;
  281. ; Here you should specify the template for calling an external mail
  282. ; program to send the download request to downloadslave.com.
  283. ;
  284. ; The template supports the following tokens:
  285. ;
  286. ; %t    To: address (this is always data@downloadslave.com)
  287. ; %r    Reply-To: address (where the file will be sent to)
  288. ; %s    Subject line with URL to download
  289. ; %m    Message body containing the required password
  290. ; %f    File containing a copy of the message body
  291. ;
  292. ; If you do not specifiy a template the mail program configured in AWeb's
  293. ; network settings will be used. AWebResume will invoke this mail program
  294. ; by asking you to submit a mailto: form. It is recommended that you
  295. ; configure MailTemplate since there is no standard way to submit a
  296. ; message body using mailto: (however, AWeb's integrated mail program
  297. ; will recognise the message body submitted by AWebResume).
  298.  
  299. ; Example template for use with YAM 2.0 by Marcel Beck (note that this
  300. ; only works if YAM is not already running, an ARexx script would be
  301. ; needed for the general case).
  302. ;
  303. ;MailTemplate    "YAM MAILTO=%t SUBJECT="%s" LETTER="%f""
  304.  
  305.  
  306.               ****************************
  307.               *                          *
  308.               * Logging related settings *
  309.               *                          *
  310.               ****************************
  311.  
  312.  
  313. ; LogEnable (BOOL)
  314. ;
  315. ; Set LogEnable to 1 to enable event logging. If you enable this option
  316. ; you must also specify a log file to output to using LogOutput. The log
  317. ; stores information about resumption and download by mail attempts so
  318. ; that you have a record to refer back to in case an event fails.
  319.  
  320. LogEnable    1
  321.  
  322.  
  323. ; LogOutput (STRING)
  324. ;
  325. ; Specifies the file to send logging information to.
  326.  
  327. LogOutput    "AWebResume.log"
  328.  
  329.  
  330.                **************************
  331.                *                        *
  332.                * Miscellaneous settings *
  333.                *                        *
  334.                **************************
  335.  
  336.  
  337. ; ShareEnable (BOOL)
  338. ;
  339. ; Set ShareEnable to 1 if you want AWebResume to open AWeb's download
  340. ; files in shared read/write mode. This will allow you to read files
  341. ; while they are still being downloaded. Take care when doing this
  342. ; however as some programs will crash when given truncated files.
  343. ; You should test the program first to give yourself confidence it
  344. ; implements decent error/truncation detection. LhA is very robust
  345. ; in this respect, you can often view the contents of an archive
  346. ; and extract documentation to read before a download has completed.
  347.  
  348. ShareEnable    1
  349.  
  350.  
  351. ; HuntEnable (BOOL)
  352. ;
  353. ; Our history deserves a closer look.
  354.  
  355. HuntEnable    1
  356.  
  357.  
  358. ; AutoFlush (BOOL)
  359. ;
  360. ; This option tells AWebResume how to flush any temporary HTML files
  361. ; it might generate. Temporary HTML files are loaded into AWeb using
  362. ; the "file://localhost/" scheme.
  363. ;
  364. ; Setting AutoFlush tells AWebResume to generate a temporary HTML file
  365. ; when required, load it into AWeb, then delete it. Whilst this procedure
  366. ; is desirable for keeping memory overheads to a minimum it can cause
  367. ; problems if documents are flushed from AWeb's memory cache before
  368. ; you've finished with them.
  369. ;
  370. ; Clearing AutoFlush prevents AWebResume from deleting temporary HTML
  371. ; files until AWeb's shutdown is detected.
  372.  
  373. AutoFlush    0
  374.  
  375.                      ******************************
  376.                      *                            *
  377.                      * Debugging related settings *
  378.                      *                            *
  379.                      ******************************
  380.  
  381.  
  382. ; DebugEnable (BOOL)
  383. ;
  384. ; Set DebugEnable to 1 to enable AWebResume's debugging mode. If you
  385. ; enable this option you must also specify a valid debugging output
  386. ; channel using DebugOutput. The debugging output is helpful if you're
  387. ; writing your own templates as the expanded template will be sent
  388. ; to the debugging channel when an external program is called.
  389.  
  390. DebugEnable     0
  391.  
  392.  
  393. ; DebugOutput (STRING)
  394. ;
  395. ; If DebugEnable was set to 1 then this option specifies the output
  396. ; channel to send the debugging information to. This should be given
  397. ; as a standard AmigaDOS file specification. If the output is to a
  398. ; file which already exists then the output will be appended to the
  399. ; existing file otherwise a new file will be created. If the output is
  400. ; to a window then the following control characters are also available
  401. ; for debugging purposes:
  402. ;
  403. ; ^C    Update settings from AWebResume's configuration file
  404. ; ^D    Update settings from AWeb's network configuration file
  405. ; ^E    Update settings from AWeb's program configuration file
  406. ; ^F    Flush URL/filename hash entries currently not in use
  407.  
  408. DebugOutput     "CON:////AWebResume Debugging Window/AUTO/CLOSE/INACTIVE"
  409.